Xerr API/com.hiusers.xerr.api.screen

Package-level declarations

Types

class ScreenAction : ScriptAction<Any?>

data class ScreenEffectAnimation(val duration: Int = 0, val easing: String = "linear")

data class ScreenEffectAnimations(val enter: ScreenEffectAnimation = ScreenEffectAnimation(12, "ease-out"), val exit: ScreenEffectAnimation = ScreenEffectAnimation(10, "ease-in"))

ScreenEffectDefinition

data class ScreenEffectDefinition(val type: String = "letterbox", val mode: String = "fixed", val height: Int = 36, val ratio: Double = 2.39, val color: String = "#000000", val opacity: Double = 1.0, val top: Boolean = true, val bottom: Boolean = true, val priority: Int = 0, val animation: ScreenEffectAnimations = ScreenEffectAnimations(), val duration: Int = 0, val markers: Map<String, Int> = linkedMapOf(), val layers: LinkedHashMap<String, ScreenLayerDefinition> = linkedMapOf())

A persistent letterbox or a finite, layered screen scene.

ScreenEffectEnd

enum ScreenEffectEnd : Enum<ScreenEffectEnd>

ScreenEffectHandle

class ScreenEffectHandle

ScreenEffectType

enum ScreenEffectType : Enum<ScreenEffectType>

ScreenGeometryRegistry

object ScreenGeometryRegistry

Shader programs addressed by a dedicated marker range; scene progress is carried separately in component RGB.

ScreenImageReference

data class ScreenImageReference(val namespace: String = "", val basename: String = "", val id: String = "")

ScreenLayerDefinition

data class ScreenLayerDefinition(val type: String = "shape", val start: Int = 0, val duration: Int = 20, val color: String = "#FFFFFF", val opacity: Double = 1.0, val easing: String = "ease-in-out", val animation: String = "fill", val style: String = "band", val pattern: String = "linear", val direction: String = "left-to-right", val mode: String = "center-out", val angle: Double = 0.0, val width: Double = 160.0, val height: Double = 0.0, val anchor: GuiAnchor = GuiAnchor(50f, 50f), val x: Double = 0.0, val y: Double = 0.0, val rotation: Double = 0.0, val image: ScreenImageReference? = null, val layout: String? = null, val variables: Map<String, String> = linkedMapOf(), val refresh: Int = 5, val enter: ScreenLayerTransition = ScreenLayerTransition(), val hold: Int = 0, val exit: ScreenLayerTransition = ScreenLayerTransition(), val distance: Double = 80.0, val overshoot: Double = 1.15, val softness: Double = 0.0, val count: Int = 8, val columns: Int = 12, val rows: Int = 7, val stagger: Double = 0.0, val seed: Int = 0, val startAngle: Double = -90.0, val clockwise: Boolean = true)

ScreenLayerTransition

data class ScreenLayerTransition(val effect: String = "none", val duration: Int = 0, val easing: String = "linear")

XerrScreenAPI

interface XerrScreenAPI

Stable screen-effect API exposed by com.hiusers.xerr.api.XerrAPI.